home *** CD-ROM | disk | FTP | other *** search
/ MACD 5 / MACD 5.bin / workbench / blankery / swazblanker26 / misc / swazblanker.doc < prev   
Text File  |  1995-01-29  |  24KB  |  984 lines
  1. TABLE OF CONTENTS
  2.  
  3. swazblanker.library/SB_AddPrefsTaskTagList
  4. swazblanker.library/SB_BecomeBlankerTaskEnd
  5. swazblanker.library/SB_BecomeBlankerTaskTagList
  6. swazblanker.library/SB_BlankerInfoTagList
  7. swazblanker.library/SB_BlankerReady
  8. swazblanker.library/SB_CloneFrontScreenTagList
  9. swazblanker.library/SB_CloseAllPrefsTasks
  10. swazblanker.library/SB_CloseColorCycle
  11. swazblanker.library/SB_CloseCopper
  12. swazblanker.library/SB_ClrBlankerScreen
  13. swazblanker.library/SB_CreateBlankerTask
  14. swazblanker.library/SB_FreeBlankerInfo
  15. swazblanker.library/SB_FrontScreenModeID
  16. swazblanker.library/SB_GetBaseVarTagList
  17. swazblanker.library/SB_GotoBlankerHomeDir
  18. swazblanker.library/SB_HelpClose
  19. swazblanker.library/SB_HelpTagList
  20. swazblanker.library/SB_KillBlankerTask
  21. swazblanker.library/SB_LockSBBase
  22. swazblanker.library/SB_ModeSupportsCopper
  23. swazblanker.library/SB_OpenColorCycleTagList
  24. swazblanker.library/SB_OpenCopperTagList
  25. swazblanker.library/SB_OpenScreenTagList
  26. swazblanker.library/SB_OpenWindowTagList
  27. swazblanker.library/SB_PingBlankerScreen
  28. swazblanker.library/SB_RemPrefsTask
  29. swazblanker.library/SB_ResetColorCycle
  30. swazblanker.library/SB_ResetCopper
  31. swazblanker.library/SB_ReturnBlankerHomeDir
  32. swazblanker.library/SB_ServerMasterCleanUp
  33. swazblanker.library/SB_ServerMasterSetUpTagList
  34. swazblanker.library/SB_SetBaseVarTagList
  35. swazblanker.library/SB_SetBlankerScreen
  36. swazblanker.library/SB_SetCopperTagList
  37. swazblanker.library/SB_UnLockSBBase
  38. swazblanker.library/SB_AddPrefsTaskTagList swazblanker.library/SB_AddPrefsTaskTagList
  39.  
  40.  NAME
  41.     SB_AddPrefsTaskTagList -- add a prefs process to resident list (V41)
  42.  
  43.  SYNOPSIS
  44.     Node = SB_AddPrefsTaskTagList( Name, TagItems );
  45.     D0                             A0    A1
  46.  
  47.     struct BlankerPrefsNode *SB_AddPrefsTaskTagList( STRPTR, struct TagItem * );
  48.  
  49.     Node = SB_AddPrefsTaskTags( Name, Tag1, ... )
  50.  
  51.     struct BlankerPrefsNode *SB_AddPrefsTaskTags( STRPTR, Tag1, ... );
  52.  
  53.  INPUTS
  54.     Name - name of task
  55.     TagItems - currently NULL.
  56.  
  57.  RESULT
  58.     Returns a pointer to a struct BlankerPrefsNode which you
  59.     pass to SB_RemPrefsTask() when you have finished.
  60.  
  61.  SEE ALSO
  62.     SB_RemPrefsTask().
  63.  
  64. swazblanker.library/SB_BecomeBlankerTaskEnd swazblanker.library/SB_BecomeBlankerTaskEnd
  65.  
  66.  NAME
  67.     SB_BecomeBlankerTaskEnd -- finish being the blanker (V41)
  68.  
  69.  SYNOPSIS
  70.     SB_BecomeBlankerTaskEnd( Message );
  71.                              A0
  72.  
  73.     void SB_BecomeBlankerTaskEnd( struct SBMessage * );
  74.  
  75.  INPUTS
  76.     Message - as returned by SB_BecomeBlankerTaskTagList().
  77.  
  78.  RESULT
  79.     None.
  80.  
  81.  SEE ALSO
  82.     SB_BecomeBlankerTaskTagList().
  83.  
  84. swazblanker.library/SB_BecomeBlankerTaskTagList swazblanker.library/SB_BecomeBlankerTaskTagList
  85.  
  86.  NAME
  87.     SB_BecomeBlankerTaskTagList -- become the blanker task (V41)
  88.  
  89.  SYNOPSIS
  90.     Message = SB_BecomeBlankerTaskTagList( TagItems );
  91.     D0                                     A0
  92.  
  93.     struct SBMessage *SB_BecomeBlankerTaskTagList( struct TagItem * );
  94.  
  95.     struct SBMessage *SB_BecomeBlankerTaskTags( Tag1, ... );
  96.  
  97.  INPUTS
  98.     TagItems - none defined.
  99.  
  100.  RESULT
  101.     Returns a TRUE if have successfully become the blanker
  102.     task. The task should then enter the blanker routine as
  103.     normal and terminate when a SIGBREAK_CTRL_C is received.
  104.       Eg.
  105.             if( lock = SB_BecomeBlankerTaskTagList( NULL ) )
  106.             {
  107.                 Blank();
  108.                 SB_BecomeBlankerTaskEnd( lock );
  109.             }
  110.  
  111.  NOTES
  112.     This function is designed for the 'Test' feature in the
  113.     configuration for each blanker.
  114.  
  115.  SEE ALSO
  116.     SB_BecomeBlankerTaskEnd().
  117.  
  118. swazblanker.library/SB_BlankerInfoTagList swazblanker.library/SB_BlankerInfoTagList
  119.  
  120.  NAME
  121.     SB_BlankerInfoTagList -- Read info about blanker module (V41)
  122.  
  123.  SYNOPSIS
  124.     BlankerInfo = SB_BlankerInfoTagList( Name, TagList );
  125.     D0                                   A0    A1
  126.  
  127.     struct BlankerInfo *SB_BlankerInfoTagList( STRPTR, struct TagItem * );
  128.  
  129.     BlankerInfo = SB_BlankerInfoTags( name, Tag1, ... );
  130.  
  131.     struct BlankerInfo *SB_BlankerInfoTags( STRPTR, Tag1, ... );
  132.  
  133.  INPUTS
  134.     Name - filename of blanker module.
  135.     TagList - NULL;
  136.  
  137.  RESULT
  138.     BlankerInfo - structure returned containing info
  139.         about the blanker module. If NULL then the info
  140.         could not be read from the file, so it is either
  141.         an invalid filename or the file is not a blanker
  142.         module.
  143.  
  144.  SEE ALSO
  145.     SB_FreeBlankerInfo()
  146.  
  147. swazblanker.library/SB_BlankerReady       swazblanker.library/SB_BlankerReady
  148.  
  149.  NAME
  150.     SB_BlankerReady -- tell server we are running (V41)
  151.  
  152.  SYNOPSIS
  153.     SB_BlankerReady()
  154.  
  155.     void SB_BlankerReady( void );
  156.  
  157.  FUNCTION
  158.     The blanker should call this function as soon as it is
  159.     ready to blank. This is after all required resources
  160.     have been obtained, so that the server knows that the
  161.     blanker running successfully. The server will wait for
  162.     this signal or the signal from the blanker exiting
  163.     before proceeding.
  164.  
  165.  INPUTS
  166.     None.
  167.  
  168.  RESULT
  169.     None.
  170.  
  171.  SEE ALSO
  172.  
  173. swazblanker.library/SB_CloneFrontScreenTagList swazblanker.library/SB_CloneFrontScreenTagList
  174.  
  175.  NAME
  176.     SB_CloneFrontScreenTagList -- open a clone of the frontmost screen (V41)
  177.  
  178.  SYNOPSIS
  179.     Screen = SB_CloneFrontScreenTagList( ScreenPtr, WindowPtr, TagItems );
  180.     D0                                   A0         A1         A2
  181.  
  182.     struct Screen *SB_CloneFrontScreenTagList( struct Screen **,
  183.                 struct Window **, struct TagItem * );
  184.  
  185.     Screen = SB_CloneFrontScreenTags( ScreenPtr, WindowPtr, Tag1, ... );
  186.  
  187.     struct Screen *SB_CloneFrontScreenTags( struct Screen **,
  188.                 struct Window **, Tag1, ... );
  189.  
  190.  INPUTS
  191.     TagItems - pointer to (an array of) TagItem
  192.         structures, terminated by the value of TAG_END.
  193.         Currently there are none defined so always set this
  194.         to NULL.
  195.  
  196.  RESULT
  197.      Screen - an open Intuition screen.  For extended error
  198.         codes see intuition.library/OpenScreen() when Screen
  199.         is returned NULL.
  200.  
  201.  SEE ALSO
  202.     SB_OpenScreenTagList(), SB_OpenWindowTagList(),
  203.     SB_FrontScreenModeID(), intuition.library/OpenScreen()
  204.  
  205. swazblanker.library/SB_CloseAllPrefsTasks swazblanker.library/SB_CloseAllPrefsTasks
  206.  
  207.  NAME
  208.     SB_CloseAllPrefsTasks -- shutdown all preferences (V41)
  209.  
  210.  SYNOPSIS
  211.     SB_CloseAllPrefsTasks( void );
  212.  
  213.     void CloseAllPrefsTasks( void );
  214.  
  215.  FUNCTION
  216.  
  217.  INPUTS
  218.     None.
  219.  
  220.  RESULT
  221.     All the module preferences currently open will be shutdown,
  222.     this is achieved by sending a SIGBREAKF_ABORT to all the
  223.     preferences tasks (provided they have been attached through
  224.     SB_AddPrefsTaskTagList() ).
  225.  
  226.  NOTES
  227.     This function is intended for use by the server.
  228.  
  229.  SEE ALSO
  230.     SB_AddPrefsTaskTagList(), SB_RemPrefsTask().
  231.  
  232. swazblanker.library/SB_CloseColorCycle swazblanker.library/SB_CloseColorCycle
  233.  
  234.  NAME
  235.     SB_CloseColorCycle - stop and free color cycling (V41)
  236.  
  237.  SYNOPSIS
  238.     SB_CloseColorCycle( ColorCyc );
  239.                         A0
  240.  
  241.     void SB_CloseColorCycle( struct SBColorCyc * );
  242.  
  243.  INPUTS
  244.     ColorCyc - pointer as returned by SB_OpenColorCycleTagList().
  245.  
  246.  RESULT
  247.     None.
  248.  
  249.  SEE ALSO
  250.     SB_CloseColorCycleTagList()
  251.  
  252. swazblanker.library/SB_CloseCopper         swazblanker.library/SB_CloseCopper
  253.  
  254.  NAME
  255.     SB_CloseCopper - end copper banding effect (V41)
  256.  
  257.  SYNOPSIS
  258.     SB_CloseCopper( SBCopper );
  259.                     A0
  260.  
  261.     VOID SB_CloseCopper( struct SBCopper * );
  262.  
  263.  INPUTS
  264.     SBCopper - copper structure to detach from screen.
  265.  
  266.  RESULT
  267.     None.
  268.  
  269.  SEE ALSO
  270.     SB_OpenCopperTagList()
  271.  
  272. swazblanker.library/SB_ClrBlankerScreen swazblanker.library/SB_ClrBlankerScreen
  273.  
  274.  NAME
  275.     SB_ClrBlankerScreen -- clear blanker screen/window (V41)
  276.  
  277.  SYNOPSIS
  278.     SB_ClrBlankerScreen( Screen, Window);
  279.                          D0      D1
  280.  
  281.     VOID SB_ClrBlankerScreen( struct *Screen, struct *Window );
  282.  
  283.  INPUTS
  284.     Screen - pointer to screen the blanker was using.
  285.     Window - pointer to the window the blanker was using.
  286.  
  287.  RESULT
  288.     None.
  289.  
  290.  SEE ALSO
  291.     SB_SetBlankerScreen(), SB_PingBlankerScreen()
  292.  
  293. swazblanker.library/SB_CreateBlankerTask swazblanker.library/SB_CreateBlankerTask
  294.  
  295.  NAME
  296.     SB_CreateBlankerTask -- create a blanker process (V41)
  297.  
  298.  SYNOPSIS
  299.     Task = SB_CreateBlankerTask( Entry, SegList, Name, Stack);
  300.     D0                           A0     A1       A2    D0
  301.  
  302.     struct Task *SB_CreateBlankerTask(APTR, BPTR, STRPTR, ULONG);
  303.  
  304.  INPUTS
  305.     entry - entry address of blanker code. This is mutually
  306.         exclusive with the seglist parameter.
  307.     seglist - seglist of blanker module. This is mutually
  308.         exclusive with the entry parameter.
  309.     name - name of the blanker task.
  310.     stack - size of stack for the blanker task.
  311.  
  312.  RESULT
  313.     Returns a pointer to the blanker task if it was started
  314.     successfully.
  315.  
  316.  NOTES
  317.     o This should only be called by the server task.
  318.     o If you pass in a seglist and the blanker was not successfully
  319.       started the seglist will be freed.
  320.  
  321.  SEE ALSO
  322.     SB_KillBlankerTask(), dos.library/LoadSeg(),
  323.     dos.library/UnLoadSeg()
  324.  
  325. swazblanker.library/SB_FreeBlankerInfo swazblanker.library/SB_FreeBlankerInfo
  326.  
  327.  NAME
  328.     SB_FreeBlankerInfo -- Free info about blanker module (V41)
  329.  
  330.  SYNOPSIS
  331.     SB_FreeBlankerInfo( BlankerInfo );
  332.                         A0
  333.  
  334.     VOID SB_FreeBlankerInfo( struct BlankerInfo * );
  335.  
  336.  INPUTS
  337.     BlankerInfo - pointer as returned by SB_BlankerInfoTagList().
  338.  
  339.  RESULT
  340.     None.
  341.  
  342.  SEE ALSO
  343.     SB_BlankerInfo()
  344.  
  345. swazblanker.library/SB_FrontScreenModeID swazblanker.library/SB_FrontScreenModeID
  346.  
  347.  NAME
  348.     SB_FrontScreenModeID -- get the displayID of frontmost screen (V41)
  349.  
  350.  SYNOPSIS
  351.     DisplayID = SB_FrontScreenModeID()
  352.     D0
  353.  
  354.     ULONG SB_FrontScreenMode( void );
  355.  
  356.  INPUTS
  357.     None.
  358.  
  359.  RESULT
  360.     The display mode of the frontmost screen.
  361.  
  362.  SEE ALSO
  363.     SB_CloneFrontScreen(), intuition.library/OpenScreen()
  364.  
  365. swazblanker.library/SB_GetBaseVarTagList swazblanker.library/SB_GetBaseVarTagList
  366.  
  367.  NAME
  368.     SB_GetBaseVarTagList -- get swazblanker variables (V41)
  369.  
  370.  SYNOPSIS
  371.     Result = SB_GetBaseVarTagList( TagList );
  372.     D0                             A0
  373.  
  374.     ULONG SB_GetBaseVarTagList( struct TagItem * );
  375.  
  376.     ULONG SB_GetBaseVarTags( Tag1, ... );
  377.  
  378.  INPUTS
  379.     TagList - pointer to a taglist.
  380.  
  381.  TAGS
  382.  
  383.     SBBV_NumberOfPrefsTasks (LONG) - number of module
  384.         preferences tasks open (includes the main server
  385.         task if that is open).
  386.  
  387.     See SB_SetBaseVarTagList() for additional tags.
  388.  
  389.  RESULT
  390.     Returns 0 if successful.
  391.  
  392.  SEE ALSO
  393.     SB_SetBaseVarTagList().
  394.  
  395. swazblanker.library/SB_GotoBlankerHomeDir swazblanker.library/SB_GotoBlankerHomeDir
  396.  
  397.  NAME
  398.     SB_GotoBlankerHomeDir -- change directory to blankers directory (V41)
  399.  
  400.  SYNOPSIS
  401.     lock = SB_GotoBlankerHomeDir()
  402.     D0
  403.  
  404.     APTR SB_GotoBlankerHomeDir( void );
  405.  
  406.  FUNCTION
  407.  
  408.  INPUTS
  409.     None.
  410.  
  411.  RESULT
  412.     The current directory will be changed to the blanker
  413.     directory and the previously locked directory is returned.
  414.  
  415.  SEE ALSO
  416.     SB_ReturnBlankerHomeDir(),dos.library/CurrentDir(),
  417.     dos.library/Lock().
  418.  
  419. swazblanker.library/SB_HelpClose             swazblanker.library/SB_HelpClose
  420.  
  421.  NAME
  422.     SB_HelpClose -- close the help window if its open (V41)
  423.  
  424.  SYNOPSIS
  425.     SB_HelpClose( sbhelp );
  426.                   A0
  427.  
  428.     void SB_HelpClose( APTR );
  429.  
  430.  FUNCTION
  431.     Closes help window opened by SB_HelpTagList().
  432.  
  433.  INPUTS
  434.     sbhelp - pointer as returned by SB_HelpTagList().
  435.  
  436.  SEE ALSO
  437.     SB_HelpTagList(), amigaguide.library/CloseAmigaGuide().
  438.  
  439. swazblanker.library/SB_HelpTagList         swazblanker.library/SB_HelpTagList
  440.  
  441.  NAME
  442.     SB_HelpTagList -- display help file(V41)
  443.  
  444.  SYNOPSIS
  445.     sbhelp = SB_HelpTagList( Filename, Window, TagList );
  446.     D0                       A0        A1      A2
  447.  
  448.     APTR SB_HelpTagList( STRPTR, struct Window *, struct TagItem *);
  449.  
  450.     sbhelp = SB_HelpTags( Filename, Window, Tag1, ... );
  451.  
  452.     APTR SB_HelpTags( STRPTR, struct Window *, Tag1, ... );
  453.  
  454.  FUNCTION
  455.     Displays the helpfile from the SwazBlanker documentation
  456.     directory. This operation runs asyncronusly.
  457.  
  458.  INPUTS
  459.     Filename - name of file to load. This will be loaded from
  460.         the SwazBlanker documentation directory. If you are a
  461.         blanker module you should specify the SBHELP_Directory
  462.         to get the BLANKERS directory. You do not need to
  463.         add the ".guide" to the filename.
  464.     Window - parent window.
  465.     TagList - See below.
  466.  
  467.  TAGS
  468.     SBHELP_BlankerPrefs (struct BlankerPrefsNode *) - set this
  469.         if you have attached to swazblanker.library so that when
  470.         you detach from the library the help window will also be
  471.         closed.
  472.  
  473.     SBHELP_Directory (ULONG) - specify the directory where your
  474.         guide file is located. Blanker modules should have their
  475.         files located in the dir "blankers". If you do not specify
  476.         this tag you will get the path to where the guide files
  477.         are stored and so will need to specify "blankers/module.guide"
  478.         to reference your blanker.
  479.             SBHELPDIR_SYS - default path.
  480.             SBHELPDIR_BLANKERS - recommended path to blanker guides.
  481.  
  482.  RESULT
  483.     returns pointer if successful.
  484.  
  485.  SEE ALSO
  486.     SB_HelpClose(), amigaguide.library/OpenAmigaGuideAsyncA().
  487.  
  488. swazblanker.library/SB_KillBlankerTask swazblanker.library/SB_KillBlankerTask
  489.  
  490.  NAME
  491.     SB_KillBlankerTask -- create a blanker process (V41)
  492.  
  493.  SYNOPSIS
  494.     SB_KillBlankerTask( Task );
  495.                         D0
  496.  
  497.     VOID SB_KillBlankerTask(struct Task *);
  498.  
  499.  INPUTS
  500.     Task - pointer to the blanker task or NULL.
  501.  
  502.  RESULT
  503.     The blanker task will be terminated.
  504.  
  505.  NOTES
  506.     This should only be called by the server task.
  507.  
  508.  SEE ALSO
  509.     SB_CreateBlankerTask()
  510.  
  511. swazblanker.library/SB_LockSBBase           swazblanker.library/SB_LockSBBase
  512.  
  513.  NAME
  514.     SB_LockSBBase -- lock the SBBase for read/write (V41)
  515.  
  516.  SYNOPSIS
  517.     Lock = SB_LockSBBase( Mode, Flags );
  518.     D0                    D0    D1
  519.  
  520.     APTR SB_LockSBBase( ULONG, ULONG );
  521.  
  522.  FUNCTION
  523.  
  524.  INPUTS
  525.     Mode - SBLOCK_READ or SBLOCK_WRITE.
  526.     Flags - currently 0.
  527.  
  528.  RESULT
  529.     Returns Lock on the semaphore, while holding this lock
  530.     you have the read or write/read permission you requested.
  531.  
  532.  SEE ALSO
  533.     SB_UnLockSBBase().
  534.  
  535. swazblanker.library/SB_ModeSupportsCopper swazblanker.library/SB_ModeSupportsCopper
  536.  
  537.  NAME
  538.     SB_ModeSupportsCopper - test if display mode supports copper (V41)
  539.  
  540.  SYNOPSIS
  541.     Result = SB_ModeSupportsCopper( DisplayID );
  542.     D0                              D0
  543.  
  544.     BOOL SB_ModeSupportsCopper( ULONG );
  545.  
  546.  INPUTS
  547.     DisplayID - display mode to test.
  548.  
  549.  RESULT
  550.     Returns TRUE if display mode can support copper list.
  551.  
  552. swazblanker.library/SB_OpenColorCycleTagList swazblanker.library/SB_OpenColorCycleTagList
  553.  
  554.  NAME
  555.     SB_OpenColorCycleTagList - open a color cycling screen (V41)
  556.  
  557.  SYNOPSIS
  558.     ColorCyc = SB_OpenColorCycleTagList( Screen, TagList );
  559.     D0                                   A0      A1
  560.  
  561.     struct SBColorCyc *SB_OpenColorCycleTagList( struct Screen *,
  562.         struct TagItem * );
  563.  
  564.     ColorCyc = SB_OpenColorCycleTags( Screen, Tag1, ... );
  565.  
  566.     struct SBColorCyc *SB_OpenColorCycleTags( struct Screen *,
  567.         Tag1, ... );
  568.  
  569.  INPUTS
  570.     Screen - pointer to screen to color cycle
  571.     TagList - pointer to taglist. Currently no tags are defined.
  572.  
  573.  RESULT
  574.     Retuerns pointer to ColorCyc structure.
  575.  
  576.  SEE ALSO
  577.     SB_CloseColorCycle(), SB_ResetColorCycle()
  578.  
  579. swazblanker.library/SB_OpenCopperTagList swazblanker.library/SB_OpenCopperTagList
  580.  
  581.  NAME
  582.     SB_OpenCopperTagList - copper banding effect (V41)
  583.  
  584.  SYNOPSIS
  585.     SBCopper = SB_OpenCopperTagList( Screen, TagItems );
  586.     D0                               A0      A1
  587.  
  588.     struct SBCopper *SB_OpenCopperTagList( struct Screen *,
  589.         struct TagItem * );
  590.  
  591.     SBCopper = SB_OpenCopperTags( Screen, Tag1, ... );
  592.  
  593.     strcut SBCopper *SB_OpenCopperTags( struct Screen *,
  594.         Tag1, ... );
  595.  
  596.  FUNCTION
  597.     Attaches copperlist effects to a screen.
  598.  INPUTS
  599.     Screen - screen to have copper effect added to. This
  600.         screen must be able to support a copper list. If it
  601.         does not support copperlists then this function will
  602.         return NULL. See SB_ModeSupportsCopper().
  603.     TagItems - pointer to (an array of) TagItem structures, terminated
  604.         by value of TAG_END.
  605.  
  606.  TAGS
  607.     SBCOPPER_Direction - which direction the colors should, currently
  608.         only COPPER_DOWN is supported. Defaults to DOWN.
  609.  
  610.         Applicability is (I).
  611.  
  612.     SBCOPPER_Pen - pen number to use for copper list. Defaults to 1.
  613.  
  614.         Applicability is (I).
  615.  
  616.     SBCOPPER_ScanLinesPerColor - how many scanlines should be used
  617.         before changing the color. Defaults to 8 ( but this may vary
  618.         in the future depending on the display mode )
  619.  
  620.         Applicability is (I).
  621.  
  622.     SBCOPPER_Speed - how fast the copper colors should move up/down
  623.         the screen. This is in scanlines per vertical blank. Setting
  624.         this tag to ZERO results in a stable copper list.
  625.         Defaults to 1.
  626.  
  627.         Applicability is (I).
  628.  
  629.     SBCOPPER_YStart (UWORD) - vertical starting line for copper effects.
  630.  
  631.         Applicability is (IS).
  632.  
  633.     SBCOPPER_YStop (UWORD) - vertical line to stop copper effects at.
  634.  
  635.         Applicability is (IS).
  636.  
  637.     SBCOPPER_Disabled (BOOL) - set to TRUE to turn copper effects off.
  638.         If set to FALSE copper effects will be re-enabled.
  639.         (UNIMPLEMENTED).
  640.  
  641.         Applicability is (IS).
  642.  
  643.  RESULT
  644.     SBCopper - structure allocated to control the copper
  645.         task created to do the copper effect. Or NULL if out
  646.         of memory or the screen display mode does not support
  647.         copper lists.
  648.  
  649.  SEE ALSO
  650.     SB_CloseCopper(), SB_ModeSupportsCopper(), SB_SetCopperTagList().
  651.  
  652. swazblanker.library/SB_OpenScreenTagList swazblanker.library/SB_OpenScreenTagList
  653.  
  654.  NAME
  655.     SB_OpenScreenTagList -- open a screen (V41)
  656.  
  657.  SYNOPSIS
  658.     Screen = SB_OpenScreenTagList( TagItems );
  659.     D0                             A0
  660.  
  661.     struct Screen *SB_OpenScreenTagList( struct TagItem * );
  662.  
  663.     Screen = SB_OpenScreenTags( Tag1, ... );
  664.  
  665.     struct Screen *SB_OpenScreenTags( Tag1, ... );
  666.  
  667.  INPUTS
  668.     TagItems - pointer to (an array of) TagItem
  669.         structures, terminated by the value of TAG_END.
  670.         See intuition.library/OpenScreen() for tag values.
  671.  
  672.  RESULT
  673.      Screen - an open Intuition screen.  For extended error
  674.         codes see intuition.library/OpenScreen() when Screen
  675.         is returned NULL.
  676.  
  677.  SEE ALSO
  678.     SB_FrontScreenModeID(), SB_CloneFrontScreenTagList(),
  679.     intuition.library/OpenScreen()
  680.  
  681. swazblanker.library/SB_OpenWindowTagList swazblanker.library/SB_OpenWindowTagList
  682.  
  683.  NAME
  684.     SB_OpenWindowTagList -- open a Window (V41)
  685.  
  686.  SYNOPSIS
  687.     Window = SB_OpenWindowTagList( TagItems );
  688.     D0                             A0
  689.  
  690.     struct Window *SB_OpenWindowTagList( struct TagItem * );
  691.  
  692.     Window = SB_OpenWindowTags( Tag1, ... );
  693.  
  694.     struct Window *SB_OpenWindowTags( Tag1, ... );
  695.  
  696.  INPUTS
  697.     TagItems - pointer to (an array of) TagItem
  698.         structures, terminated by the value of TAG_END.
  699.         See intuition.library/OpenWindow() for tag values.
  700.  
  701.  RESULT
  702.      Window - an open Intuition Window.  For extended error
  703.         codes see intuition.library/OpenWindow() when Window
  704.         is returned NULL.
  705.  
  706.  SEE ALSO
  707.     SB_CloneFrontScreenTagList(), intuition.library/OpenWindow()
  708.  
  709. swazblanker.library/SB_PingBlankerScreen swazblanker.library/SB_PingBlankerScreen
  710.  
  711.  NAME
  712.     SB_PingBlankerScreen -- bring blanker screen to front (V41)
  713.  
  714.  SYNOPSIS
  715.     SB_PingBlankerScreen()
  716.  
  717.     VOID SB_PingBlankerScreen( void );
  718.  
  719.  INPUTS
  720.     None.
  721.  
  722.  RESULT
  723.     None.
  724.  
  725.  NOTES
  726.     This should only be called by the server task.
  727.  
  728.  SEE ALSO
  729.     SB_SetBlankerScreen(), SB_ClrBlankerScreen()
  730.  
  731. swazblanker.library/SB_RemPrefsTask       swazblanker.library/SB_RemPrefsTask
  732.  
  733.  NAME
  734.     SB_RemPrefsTask -- remove a prefs process to resident list (V41)
  735.  
  736.  SYNOPSIS
  737.     SB_RemPrefsTask( BlankerPrefsNode )
  738.                      A0
  739.  
  740.     VOID SB_AddPrefsTask( struct BlankerPrefsNode * );
  741.  
  742.  INPUTS
  743.     BlankerPrefsNode - pointer as returned by SB_AddPrefsTaskTagList().
  744.  
  745.  RESULT
  746.     None.
  747.  
  748.  SEE ALSO
  749.     SB_AddPrefsTaskTagList().
  750.  
  751. swazblanker.library/SB_ResetColorCycle swazblanker.library/SB_ResetColorCycle
  752.  
  753.  NAME
  754.     SB_ResetColorCycle - reset color cycling (V41)
  755.  
  756.  SYNOPSIS
  757.     SB_ResetColorCycle( ColorCyc );
  758.                         A0
  759.  
  760.     void SB_ResetColorCycle( struct SBColorCyc * );
  761.  
  762.  INPUTS
  763.     ColorCyc - pointer as returned by SB_OpenColorCycleTagList().
  764.  
  765.  RESULT
  766.     None.
  767.  
  768.  SEE ALSO
  769.     SB_OpenColorCycleTagList()
  770.  
  771. swazblanker.library/SB_ResetCopper         swazblanker.library/SB_ResetCopper
  772.  
  773.  NAME
  774.     SB_ResetCopper - reset copper banding effect (V41)
  775.  
  776.  SYNOPSIS
  777.     SB_ResetCopper( SBCopper );
  778.                     A0
  779.  
  780.     VOID SB_ResetCopper( struct SBCopper * );
  781.  
  782.  FUNCTION
  783.     Old function that resets the color for the copperlist.
  784.     See SB_SetCopperTagList().
  785.  INPUTS
  786.     SBCopper - copper structure to reset.
  787.  
  788.  RESULT
  789.     None.
  790.  
  791.  SEE ALSO
  792.     SB_OpenCopperTagList(),SB_SetCopperTagList().
  793.  
  794. swazblanker.library/SB_ReturnBlankerHomeDir swazblanker.library/SB_ReturnBlankerHomeDir
  795.  
  796.  NAME
  797.     SB_ReturnBlankerHomeDir -- restore original directory (V41)
  798.  
  799.  SYNOPSIS
  800.     SB_ReturnBlankerHomeDir( Lock );
  801.                              D0
  802.  
  803.     void SB_ReturnBlankerHomeDir( APTR );
  804.  
  805.  FUNCTION
  806.  
  807.  INPUTS
  808.     lock - the lock as returned by SB_GotoBlankerHomeDir().
  809.  
  810.  RESULT
  811.     Current directory will be restored to the directory as
  812.     when SB_GotoBlankerHomeDir() was invoked.
  813.  
  814.  SEE ALSO
  815.     SB_GotoBlankerHomeDir(), dos.library/CurrentDir(),
  816.     dos.library/UnLock().
  817.  
  818. swazblanker.library/SB_ServerMasterCleanUp swazblanker.library/SB_ServerMasterCleanUp
  819.  
  820.  NAME
  821.     SB_ServerMasterCleanUp -- cleanup the master task for the server (V41)
  822.  
  823.  SYNOPSIS
  824.     SB_ServerMasterCleanUp();
  825.  
  826.     VOID SB_ServerMasterCleanUp( void );
  827.  
  828.  INPUTS
  829.     None.
  830.  
  831.  RESULT
  832.     None.
  833.  
  834.  SEE ALSO
  835.     SB_ServerMasterSetUp()
  836.  
  837. swazblanker.library/SB_ServerMasterSetUpTagList swazblanker.library/SB_ServerMasterSetUpTagList
  838.  
  839.  NAME
  840.     SB_ServerMasterSetUpTagList -- setup the master task for the server (V41)
  841.  
  842.  SYNOPSIS
  843.     Success = SB_ServerMasterSetUpTagList( TagList );
  844.     D0                                     A0
  845.  
  846.     BOOL SB_ServerMasterSetUpTagList(struct TagItem *);
  847.  
  848.     BOOL SB_ServerMasterSetUpTags( Tag1, ... );
  849.  
  850.  INPUTS
  851.     TagList - array of tag items to specify.
  852.  
  853.  TAGS
  854.     SBBV_DocPath (STRPTR) - full pathname to where the
  855.         blanker modules are.
  856.  
  857.  RESULT
  858.     Returns TRUE if we were able to initialize the
  859.     swazblanker.library to service the server task.
  860.  
  861.  SEE ALSO
  862.     SB_ServerMasterCleanUp()
  863.  
  864. swazblanker.library/SB_SetBaseVarTagList swazblanker.library/SB_SetBaseVarTagList
  865.  
  866.  NAME
  867.     SB_SetBaseVarTagList -- set swazblanker variables (V41)
  868.  
  869.  SYNOPSIS
  870.     Result = SB_SetBaseVarTagList( TagList );
  871.     D0                             A0
  872.  
  873.     ULONG SB_SetBaseVarTagList( struct TagItem * );
  874.  
  875.     ULONG SB_SetBaseVarTags( Tag1, ... );
  876.  
  877.  INPUTS
  878.     TagList - pointer to a taglist.
  879.  
  880.  TAGS
  881.     SBBV_ObtainSemaphore (BOOL) - if TRUE then the
  882.         SwazBlankerBase->Semaphore will be locked for
  883.         access. Only set this to FLASE if you already
  884.         have the correct read/write access to the semaphore.
  885.  
  886.     SBBV_FontInfo (STRPTR) - name of the font to use for the
  887.         user interface for blanker modules.
  888.  
  889.     SBBV_PrefsWindow (struct Window *) - pointer to the
  890.         SwazBlanker preferences window if it is open or NULL
  891.         if it is not.
  892.  
  893.     SBBV_BlankerPath (STRPTR) - full path to the directory
  894.         where the blanker modules are stored.
  895.  
  896.     SBBV_DocPath (STRPTR) - full path to the directory where
  897.         the documentation files are stored.
  898.  
  899.     SBBV_BlankerTaskPri (LONG) - the task priority to run
  900.         blanker modules at.
  901.  
  902.  RESULT
  903.     Returns 0 if successful.
  904.  
  905.  SEE ALSO
  906.     SB_SetBaseVarTagList().
  907.  
  908. swazblanker.library/SB_SetBlankerScreen swazblanker.library/SB_SetBlankerScreen
  909.  
  910.  NAME
  911.     SB_SetBlankerScreen -- set blanker screen/window (V41)
  912.  
  913.  SYNOPSIS
  914.     Error = SB_SetBlankerScreen( Screen, Window);
  915.     D0                           D0      D1
  916.  
  917.     ULONG SB_SetBlankerScreen( struct *Screen, struct *Window );
  918.  
  919.  INPUTS
  920.     Screen - pointer to screen opened by the blanker.
  921.     Window - pointer to window on the screen.
  922.  
  923.  RESULT
  924.     Returns non zero if error occured.
  925.  
  926.  SEE ALSO
  927.     SB_ClrBlankerScreen(), SB_PingBlankerScreen()
  928.  
  929. swazblanker.library/SB_SetCopperTagList swazblanker.library/SB_SetCopperTagList
  930.  
  931.  NAME
  932.     SB_SetCopperTagList - Set copper effect values (V41)
  933.  
  934.  SYNOPSIS
  935.     SB_SetCopperTagList( SBCopper, TagItems );
  936.                          A0        A1
  937.  
  938.     void SB_SetCopperTagList( struct SBCopper *, struct TagItem * );
  939.  
  940.     SB_SetCopperTags( SBCopper, Tag1, ... );
  941.  
  942.     void SB_SetCopperTags( strcut SBCopper *, Tag1, ... );
  943.  
  944.  INPUTS
  945.     SBCopper - copper structure to reset.
  946.     TagItems - pointer to (an array of) TagItem structures,
  947.         terminated by the value of TAG_END. Currently there
  948.         are none defined so always set this to NULL.
  949.  
  950.  TAGS
  951.     SBCOPPER_RandomiseColors (BOOL) - if set to true then the
  952.         colors being currently used for the copper will be
  953.         randomised.
  954.  
  955.     See SB_OpenCopperTagList() for additional values.
  956.  RESULT
  957.     Copper list effect variables are changed.
  958.  
  959.  SEE ALSO
  960.     SB_OpenCopperTagList(), SB_ResetCopper().
  961.  
  962. swazblanker.library/SB_UnLockSBBase       swazblanker.library/SB_UnLockSBBase
  963.  
  964.  NAME
  965.     SB_UnLockSBBase -- unlock the SBBase (V41)
  966.  
  967.  SYNOPSIS
  968.     SB_UnLockSBBase( Lock );
  969.                      A0
  970.  
  971.     SB_UnLockSBBase( APTR );
  972.  
  973.  FUNCTION
  974.  
  975.  INPUTS
  976.     Lock - as returned by SB_LockSBBase().
  977.  
  978.  RESULT
  979.     None.
  980.  
  981.  SEE ALSO
  982.     SB_LockSBBase().
  983.  
  984.